home *** CD-ROM | disk | FTP | other *** search
/ FishMarket 1.0 / FishMarket v1.0.iso / fishies / 051-075 / disk_059 / browser2 / browser.doc < prev    next >
Text File  |  1992-05-06  |  7KB  |  120 lines
  1. Credits:
  2. Browser, Copyright (c) 1987 Daniel Green
  3. Browser may be redistributed without fee, provided that the copyright
  4. notice is maintained and that this documentation accompanies the code.
  5.  
  6. Purpose:
  7. Browser lets you view up to eight text files at one time.  The "Browser"
  8. is a window that displays the names of all the files in the current
  9. directory, and that lets you go up and down the directory tree.  From
  10. the Browser window you can select files to view.  Files that you are
  11. viewing each appear in their own "Viewer" windows.
  12.  
  13. Operating the Browser Window:
  14. When you start the program (by typing BROWSER from the CLI) the Browser
  15. window appears.  It looks like this:
  16.  
  17.     Inner Folders     Outer Folders     Change Drives   (menus)
  18.  
  19.         += Browser =================== BF +
  20.         | +--------------------------+ /\ |
  21.         | |######First file name#####| || |  (highlighted name)
  22.         | |      Second file name    | || |
  23.         | |      Third file name     | || |
  24.         | |      Fourthfile name     | || |
  25.         | |      Fifth file name     | || |
  26.         | |      Sixth file name     | || |
  27.         | |      Seventh file name   | || |
  28.         | +--------------------------+ \/ |
  29.         | +------+             +--------+ |
  30.         | | Open |             |  Quit  | |
  31.         | +------+             +--------+ |
  32.         +---------------------------------+
  33.  
  34.    The browser starts off displaying files in the current directory,
  35. sorted alphabetically from 'A' to 'Z' and then from 'a' to 'z'.
  36. If a file that you want to view resides in this directory, you can
  37. scroll through the list of files until the highlight bar rests on top
  38. of the file you want to view.  Scrolling is accomplished in many ways.
  39. You can click on the up or down arrows to scroll one line at a time,
  40. you can drag the scroll bar (prop gadget) around, or you can click in
  41. the scroll bar box to scroll up or down a windowful of filenames at a
  42. time.  If the filename that you want is one of the seven appearing in
  43. the window, you can also directly click on that name with the mouse.
  44. For those who don't like mice, you can use the keyboard arrow keys --
  45. up and down arrows will scroll up or down one filename at a time.
  46. Holding down the shift key while pressing an arrow will display either
  47. the first windowful (for SHIFT up-arrow) or the last windowful (for
  48. SHIFT down-arrow) of filenames.  To activate a file for viewing, you can
  49. either press the OPEN button while the desired filename is highlighted,
  50. or mouse double-click on the filename, or press the keyboard RETURN or
  51. ENTER keys while the desired filename is highlighted.
  52.    If you want to view a file that is not in the current directory, you
  53. use the menus.  In the Browser terminology, a "Folder" is a synonym
  54. with "directory".  The "Inner Folders" menu contains an alphabetically
  55. sorted list of all the subdirectories, or folders, that are contained
  56. in the current directory.  Clicking on one of these menu entries will
  57. cause the Browser to show files in that directory.  The clicked-on
  58. folder will become the new current directory.  The "Outer Folders"
  59. menu contains a hierarchical list of all the parent directories of
  60. the current directory.  The first entry is the current directory itself.
  61. You can select this if for some reason you want Browser to re-read the
  62. list of files in the current directory.  The next entry is the folder
  63. that contains the current directory, and so on.  The final entry in this
  64. menu is the name of the disk drive that this folder resides on; this is
  65. the root of the current directory.  As with the Inner Folders, clicking
  66. on one of these folder names will cause that to become the new current
  67. directory, and cause the Browser display to update.  The final menu is
  68. called "Change Drives", and lists all the drives in the system (including
  69. RAM: and any other ram disks, hard disks, or floppies) alphabetically
  70. sorted.  Clicking on one of these will change the current directory to
  71. the root of that disk, and update the Browser display.
  72.    Brief messages will be displayed if the current directory has no
  73. files within it, if there are no Inner Folders in the current folder,
  74. or if there are no drives with mounted disks.
  75.    Clicking on the QUIT button will close any viewer windows that are open,
  76. and exit the program.  Pressing the HELP key on the keyboard will display
  77. a copyright message.  The Browser window can also be dragged and depth
  78. arranged.
  79.  
  80. Operating the Viewer Windows:
  81.    Files that have been selected and activated by the Browser are
  82. viewed in Viewer windows.  Each window can be dragged, closed, depth
  83. arranged, and resized.  Each window has a horizontal and a vertical
  84. scroll bar, so that if the text of the file is larger then the window
  85. size, you can scroll the window over the text.  Scrolling is accomplished
  86. by either mouse or keyboard.  With the mouse you can click and drag the
  87. scroll bar, or you can click on the scroll box to move up or down a
  88. windowful of text.  Using the keyboard arrow keys, you can scroll the
  89. window up, down, left, or right one line.  If you hold down the SHIFT
  90. key with an arrow key the window will scroll to the extreme edge in
  91. the desired direction.  For instance, SHIFT up-arrow will scroll to the
  92. top of the file, while SHIFT right-arrow will move the window to display
  93. the rightmost portion of the file.
  94.    Additional keys are supported that emulate the UNIX(tm) "more" file
  95. displayer.  Pressing the space bar will scroll down a page worth of
  96. text.  Pressing the RETURN or ENTER keys will scroll down one line of
  97. text, just like the down arrow.
  98.    To close the viewer window, you can either click in the window close
  99. box, or you can type the "Q" key.  Pressing the HELP key will display
  100. the copyright notice.
  101.    Pressing the ESC escape key will call up the Browser window to the
  102. front of the Workbench screen.
  103.    The Viewer windows can only display text.  All non-text characters,
  104. including tabs, are converted into spaces at the rate of one space per
  105. control character.
  106.  
  107. Special Considerations:
  108.    If you eject a disk from a floppy drive while that disk's directory
  109. is being displayed in the Browser, nothing ill will happen, but
  110. obviously if you try to open a file or folder on the (now non-mounted)
  111. disk, a disk requester will appear asking you to re-insert the disk.
  112.    Tabs are not expanded to their full length but are merely converted
  113. to a single space per tab.
  114.  
  115. Future Work:
  116.    Should the Folder menus be disabled if the disk containing the
  117. current directory is dis-mounted?  I'm not sure yet.  The Viewer windows
  118. should have a search.  My ultimate goal is to convert the Viewer to
  119. an Editor, but don't hold your breath...
  120.